home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 4 / CU Amiga Magazine's Super CD-ROM 04 (1996)(EMAP Images)(GB)(Track 1 of 3)[!][issue 1996-11].iso / magazine / psion / utils / elvis.lzx / readme.3a < prev   
Text File  |  1984-02-27  |  14KB  |  299 lines
  1.                 ELVIS for the Psion 3a and Compatibles
  2.                 ======================================
  3.                            7th June 1996
  4.                     Psion 3a version - 6.1 release
  5.         
  6.         INTRODUCTION
  7.         ~~~~~~~~~~~~
  8.         This information is intended to provide information
  9.         that is specific to the Psion 3a implementation of ELVIS.
  10.  
  11.         ELVIS was ported to the Psion 3a by Keith and Dave Walker.
  12.         The port is based on the ELVIS v1.8 patch level 4 source.
  13.         The key features of this port are:
  14.  
  15.           -  Command level compatibility with the Unix "vi" editor
  16.              program so that users of "vi" will instantly be able
  17.              to use the ELVIS program.
  18.  
  19.           -  The ability to edit larger files than arem possible
  20.              with the Text Editor built into the Psion 3a.  The
  21.              file size is limited only by the size of the RAM
  22.              disk that you can give to ELVIS to create its
  23.              temporary files on.
  24.  
  25.         The port was done to provide us with an alternative text
  26.         editor to that built into the Psion 3a that was more
  27.         suitable to editing and amending source code files. This
  28.         was done as part of developing a complete C development
  29.         system hosted on the Psion 3a.  This C development system
  30.         is being released under the name of CPOC (which is a play
  31.         on EPOC as the name of the Psion operating system and
  32.         "C in your POCket" as a description of the capability).
  33.  
  34.  
  35.         INSTALLATION AND RUNNING
  36.         ~~~~~~~~~~~~~~~~~~~~~~~~
  37.         The files provided are as follows:
  38.  
  39.             README              The original ELVIS README file
  40.             README.3a           Psion 3a specific information
  41.             ELVIS.APP           The ELVIS program itself
  42.             ELVIS.INI           Sample initialisation file
  43.  
  44.     The ELVIS.APP file requires about 128K of system memory to run (64K
  45.     code and 64K data).  It is therefore only really suitable for
  46.     running on the larger Psion S3a models or one which has been
  47.     expanded with SSDs.
  48.  
  49.         The ELVIS.APP file can be installed in any directory that
  50.         you like.   We would recommend that you put it into either
  51.         the "\APP\" directory or the "\CPOC\" directory on any drive.
  52.         If it is placed in this location it will automatically be
  53.         integrated into the CPOC system when it becomes available.
  54.  
  55.         If you have any resource files (files with names of the
  56.         form ELVISnn.RSC) then these should be installed in an
  57.         ELVIS sub-directory relative to the point at which the
  58.         ELVIS.APP file is installed.  These additional resource
  59.         files are only used for nob-
  60.  
  61.         You can install ELVIS using the standard Psion-I sequence.
  62.         As supplied, ELVIS will look for files in the \TXT directory
  63.         on any drive that have a .TXT extension.  By making use of
  64.         list facility you can specify alternative file locations and
  65.         file extensions.  This is mentioned in section 16 of the
  66.         User Guide manual (the chapter called "The System Screen").
  67.  
  68.         If you have a command line processor (such as the CMDP package
  69.         released by Psion) then you can also start ELVIS (or one of
  70.         its aliases) from the command line.  You will need to specify
  71.         the full path name if you do not want to use the default one.
  72.  
  73.         Finally, if you have already loaded ELVIS you can use one of the
  74.         built in ELVIS commands (such as the "r" or "e" commands) to load
  75.         the required file.
  76.  
  77.  
  78.         TEMPORARY FILE
  79.         ~~~~~~~~~~~~~~
  80.         While ELVIS is editing a file, it uses a temporary file to
  81.         keep track of all the changes that you are making.  The
  82.         location of this temporary file is decided as follows:
  83.  
  84.           -  If the ELVIS initialisation file exists (see below) and
  85.              it contains a line such for the form
  86.                  set directory=A:\TMP\
  87.              then this is used as the location of temporary files.
  88.  
  89.           -  If the ELVIS initialisation file does not exist and
  90.              if the "TMP" or "TEMP" environment variables are set
  91.              then the directory that they point to is used for the
  92.              ELVIS temporary files.
  93.  
  94.           -  If none of the above are true then ELVIS will assume the
  95.              location "\"  (i.e. the root directory of the default
  96.              drive) is to be used for temporary files.
  97.  
  98.         It is the users responsibility to ensure that the relevant
  99.         directory for temporary files does in fact exist.  If it does
  100.         not, then ELVIS will fail while loading.
  101.  
  102.  
  103.         INITIALISATION FILE
  104.         ~~~~~~~~~~~~~~~~~~~
  105.         The normal "vi" editor when running on a Unix system allows
  106.         you to set up a file called ".exrc" that holds start up
  107.         configuration details.   The Psion 3a port of ELVIS uses
  108.         a file called "ELVIS.INI" instead.   This file (if present)
  109.         is expected to be a text file that is held in the same
  110.         directory as the ELVIS.APP file.
  111.  
  112.         This file is normally the easiest way to specify the location
  113.         for the ELVIS temporary files.   You can create an initial
  114.         ELVIS.INI file by loading the WORD application built into the
  115.         Psion 3a and saving the resulting file as file of type "TEXT".
  116.         Subsequently you can use ELVIS itself to edit the ELVIS.INI
  117.         file.
  118.  
  119.         To make it easier for you, we have provided a sample ELVIS.INI
  120.         file.  You can use this as a starting point, and tailor it to
  121.         suit you particular system and preferences.
  122.  
  123.     There is a psion specific numeric variable called fontindex (fi)
  124.     which can be used to specify the size of the font to be used.
  125.     The variable can take a value between 0 and 4, the values
  126.     representing the font sizes 6-point, 8-point, 11-point, 13-point
  127.     and 16-point.   By using this variable in the ELCIS.INI file it
  128.     is possible to specify which font to use on startup.
  129.  
  130.  
  131.         DOCUMENTATION
  132.         ~~~~~~~~~~~~~
  133.         The author of ELVIS provides a full manual on its use and
  134.         facilities (about 120 pages).  This manual is provided in
  135.         the Unix ROFF format.  If you want the raw ROFF format
  136.         version of the documentation, then it is widely available on
  137.         one of the many Internet sites that hold ELVIS source.  A
  138.         good site in the UK is "ic.ac.uk" (Imperial College).
  139.  
  140.         For Psion users, we have processed the ROFF format documentation
  141.         files to produce a single formatted text file  (about 200Kb
  142.         in size).  As we expect many of the typical users of ELVIS
  143.         to already be familiar with the "vi" program, we have not
  144.         included this documentation in the same package as the main
  145.         ELVIS application program, but instead made it a separate file
  146.         (ELVISDOC.ZIP) that you only need to download if you want it.
  147.  
  148.  
  149.         CHANGING FONT SIZE
  150.         ~~~~~~~~~~~~~~~~~~
  151.         A special feature of the Psion port is the support for a range
  152.         of different font sizes.   You can toggle round the available
  153.         fonts by using the Psion-Z keypress (or Psion-Shift-Z to go the
  154.         other way).
  155.  
  156.         There is also a new 'set' option so that you can add your
  157.         favourite font setup to the ELVIS.INI file.  This 'set' option
  158.         uses the keyword 'fontindex' (abbreviation is'fi') followed
  159.         by a numeric value to specify the font.  The values supported
  160.         are:
  161.             0     6 point monospace font
  162.             1     8 point Swiss font
  163.             2     11 point Swiss font
  164.             3     13 point Swiss font
  165.             4     15 point Swiss font
  166.         As you change the font size, the number of lines on the screen
  167.         and the number of columns will be automatically adjusted to fit
  168.         into the available screen area.
  169.  
  170.         You can find out the current settings of the fontindex and the
  171.         number of screen ros and columns at any time by using the 'set'
  172.         command with no parameters.
  173.  
  174.  
  175.         LIMITATIONS
  176.         ~~~~~~~~~~~
  177.         At this release we have not ported to the 3a the ancilliary
  178.         programs that can be used in conjunction with ELVIS.  These
  179.         include programs such as "FORMAT" and "TAGS".  Therefore
  180.         any command which depend on the presence of such ancilliary
  181.         programs will not work.  Also the Psion 3a does not have a
  182.         command shell, so the colon mode "!" command will not work.
  183.  
  184.         Finally due to the 64Kb limitation that the Psion 3a imposes
  185.         as the maximum size of the code for any program, we have had
  186.         to omit some of the optional features.  For those who want to
  187.         look at the section of the ELVIS documentation that talks about
  188.         the options used when building it, the following details the
  189.         build time options we defined to omit optional features
  190.  
  191.                 NO_COLOR
  192.                 NO_CURSORSHAPE
  193.                 NO_DIGRAPH
  194.                 NO_ERRLIST
  195.                 NO_EXTENSIONS
  196.                 NO_FKEY
  197.                 NO_IF
  198.                 NO_LEARN
  199.                 NO_MKEXRC
  200.                 NO_POPUP
  201.                 NO_REFORMAT
  202.                 NO_VISIBLE
  203.  
  204.  
  205.         FOREIGN LANGUAGE VERSIONS OF ELVIS
  206.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  207.  
  208.         The ELVIS.APP file as supplied has all its messages in English.
  209.         However the port of ELVIS was done with support for foreign
  210.         languages in mind, so all messages are held in the form of a
  211.         Psion Resource file.
  212.  
  213.         We do not actually have the skill ourselves to translate messages
  214.         to a foreign language.  What we are doing therefore is making the
  215.         source for the English version of the ELVIS resource file
  216.         generally available in the hope that others will be interested
  217.         in doing the necessary translation.  This source, and the
  218.         necessary additional information to make use of it is being
  219.         uploaded as the ELVISRSS.ZIP file.
  220.  
  221.         When such resource files become available, they will have file
  222.         names of the form ELVISnn.RSC where 'nn' is the EPOC country
  223.         code (01 for English).   These files should then be installed
  224.         in an ELVIS sub-directory relative to the location at which
  225.         the ELVIS.APP file has been installed.  On start-up ELVIS will
  226.         look for such files, and if there is one present which has the
  227.         correct country code for the Psion in question it will use it in
  228.         preference to the built-in English version.
  229.  
  230.  
  231.         CONTACTS FOR THE PSION 3A PORT OF ELVIS
  232.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  233.  
  234.         The original ELVIS program was developed by Steve Kirkendall.
  235.         Steve is aware that the Psion 3a port has occured, but is not
  236.         actively involved in it in any way.
  237.  
  238.         The Psion 3a port was done by:
  239.  
  240.             Dave Walker
  241.                        email:       d.j.walker@slh0101.wins.icl.co.uk
  242.                        compuserve:  100141,2626
  243.                        msn:         itimpi@msn.com
  244.  
  245.             Keith Walker:
  246.                        email:       kdw@oasis.icl.co.uk
  247.  
  248.  
  249.         CHANGE HISTORY
  250.         ~~~~~~~~~~~~~~
  251.         20 July 1995  - Initial release for the Psion 3a
  252.  
  253.         13 Aug 1995   - ELVIS program now a file based ".APP" file.
  254.                       - Faster screen updating.
  255.                       - The Temporary directory changed to default to
  256.                         the root directory of the current default drive.
  257.  
  258.     15 Aug 1995   - After a :e, :n or :f command the file being edited
  259.             is updated on the system screen.
  260.  
  261.     20 Aug 1995   - Fixed the X p N and , commands (porting problem).
  262.             Updated :version command with Psion release info.
  263.             Moved messages into a resource file - frees
  264.             about 5K in data area.
  265.             :sh command now actualy runs contents of shell
  266.             variable (but :!command still doesn't work)
  267.  
  268.         04 Oct 1995   - Psion 3a 5th Release
  269.                         Psion-X writes file and exits elvis
  270.             Shift-Psion-X exits elvis with no write
  271.             Delete key on system screen now handled
  272.             Elvis now goes "busy" when performing long task.
  273.             (Shift-)Psion-Z changes font size.
  274.             new :set variable fontindex
  275.             fixed a couple of messages.
  276.  
  277.         07 May 1996   - Psion 3a 6th Release
  278.                       - Rebuilt using the "286" option of the TopSpeed
  279.                         Compiler which produced enough code reduction to
  280.                         allow fancier handling of regular expressions to
  281.                         be included.  This means that a number of more
  282.                         advanced Elvis options relating to the use of
  283.                         'magic' are now available in the Psion 3a version.
  284.                       - Changes to make ELVIS use language dependent
  285.                         resource files when running on a non-English system.
  286.                       - The Resource file made generally available to
  287.                         encourage development of non-English versions.
  288.                       - Will now read screen size and try to use all the
  289.                         available space.  If used under the Psion 3a
  290.                         emulator, the displayed size is now up to 50 lines
  291.                         by 100 characters (previously was 22 x 80).
  292.  
  293.         07 June 1996  - Psion 3a 6.1 release
  294.                       - Corrected problem introduced in 6.0 release that
  295.                         meant Psion-Z only works for two smallest font sizes.
  296.                       - Reduced maximum lines displayed under Psion 3a
  297.                         emulator to be 29 lines x 80 characters as part
  298.                         of correcting problem.
  299.